core/androidx.core.content/[main]ContentResolverCompat/query

query

@Nullable
open fun query(@NonNull resolver: ContentResolver, @NonNull uri: Uri, @Nullable projection: Array<String>, @Nullable selection: String, @Nullable selectionArgs: Array<String>, @Nullable sortOrder: String, @Nullable cancellationSignal: CancellationSignal): Cursor(source)

Query the given URI, returning a Cursor over the result set with optional support for cancellation.

For best performance, the caller should follow these guidelines:

  • Provide an explicit projection, to prevent reading data from storage that aren't going to be used.
  • Use question mark parameter markers such as 'phone=?' instead of explicit values in the selection parameter, so that queries that differ only by those values will be recognized as the same for caching purposes.

Return

A Cursor object, which is positioned before the first entry, or null

Parameters

resolver

resolver to use for the query.

uri

The URI, using the content:// scheme, for the content to retrieve.

projection

A list of which columns to return. Passing null will return all columns, which is inefficient.

selection

A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will return all rows for the given URI.

selectionArgs

You may include ?s in selection, which will be replaced by the values from selectionArgs, in the order that they appear in the selection. The values will be bound as Strings.

sortOrder

How to order the rows, formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Passing null will use the default sort order, which may be unordered.

cancellationSignal

A signal to cancel the operation in progress, or null if none. If the operation is canceled, then OperationCanceledException will be thrown when the query is executed.

See also

@Nullable
open fun query(@NonNull resolver: ContentResolver, @NonNull uri: Uri, @Nullable projection: Array<String>, @Nullable selection: String, @Nullable selectionArgs: Array<String>, @Nullable sortOrder: String, @Nullable cancellationSignal: CancellationSignal): Cursor(source)

Deprecated

Use query

Query the given URI, returning a Cursor over the result set with optional support for cancellation.

For best performance, the caller should follow these guidelines:

  • Provide an explicit projection, to prevent reading data from storage that aren't going to be used.
  • Use question mark parameter markers such as 'phone=?' instead of explicit values in the selection parameter, so that queries that differ only by those values will be recognized as the same for caching purposes.

Return

A Cursor object, which is positioned before the first entry, or null

Parameters

resolver

resolver to use for the query.

uri

The URI, using the content:// scheme, for the content to retrieve.

projection

A list of which columns to return. Passing null will return all columns, which is inefficient.

selection

A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will return all rows for the given URI.

selectionArgs

You may include ?s in selection, which will be replaced by the values from selectionArgs, in the order that they appear in the selection. The values will be bound as Strings.

sortOrder

How to order the rows, formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Passing null will use the default sort order, which may be unordered.

cancellationSignal

A signal to cancel the operation in progress, or null if none. If the operation is canceled, then OperationCanceledException will be thrown when the query is executed.

See also